home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / man / cat.1 / xboing.1 < prev    next >
Text File  |  1995-07-25  |  17KB  |  595 lines
  1.  
  2.  
  3.  
  4.      XBOING(6)        X Version 11 (August 1993)         XBOING(6)
  5.  
  6.  
  7.  
  8.      NAME
  9.       xboing - An X    Window System based blockout clone. V1.7
  10.  
  11.  
  12.      SYNOPSIS
  13.       xboing [-version] [-usage] [-help] [-sync] [-display
  14.       <displayName>] [-speed <1-10>] [-scores] [-keys] [-sound]
  15.       [-setup] [-nosfx] [-nograb] [-maxvol <1-100>]    [-startlevel
  16.       <1-MAXLEVELS>] [-usedefcmap]
  17.  
  18.           -speed <n>     - The game speed, 1 - 9. 9=Fast
  19.           -maxvol <n>     - The maximum volume as percentage
  20.           -startlevel <n>     - The starting    level for game.
  21.           -help         - Produce this    help message.
  22.           -sync         - Turn    on X synchronisation.
  23.           -usage         - Print a brief help message.
  24.           -version         - Print out the current version.
  25.           -scores         - Print out current highscores.
  26.           -keys         - Use keys instead of mouse control.
  27.           -sound         - Turn    audio ON for game.
  28.           -setup         - Print setup information.
  29.           -nosfx         - Turn    off special effects.
  30.           -nograb         - Turn    pointer    grabbing off.
  31.           -usedefcmap     - Use the default colourmap.
  32.           -display <display> - Set the display for the game.
  33.  
  34.  
  35.      DESCRIPTION
  36.       XBoing is a simple blockout type game    where you have a
  37.       paddle which you control to bounce a ball around the game
  38.       area destroying blocks with the proton ball.
  39.  
  40.       Each block carries a different point value. The more blocks
  41.       you destroy, the better your score. The person with the
  42.       highest score    wins.
  43.  
  44.       The play area    is filled with blocks and other    objects. You
  45.       have a paddle    that can move from left    to right at the    bottom
  46.       of the arena.    You move the paddle so that the    proton ball
  47.       bounces around blowing up blocks does    not go past the    paddle
  48.       and out the bottom, much like    a pinball game.
  49.  
  50.       The blocks exhibit different behaviour. The bomb block when
  51.       hit will explode all blocks around it. If another bomb is
  52.       beside it then it will go off    also. The solid    wall brick
  53.       will not explode unless next a bomb. The ammunition block
  54.       will give you    four bullets and so on.    Special    blocks such as
  55.       reverse and machine gun will only last for one level.
  56.  
  57.       There    are random blocks that change their colour and
  58.       therefore their points every now and then. They add a    bit of
  59.       change to the    levels.
  60.  
  61.  
  62.  
  63.      Page 1                          (printed 9/2/93)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XBOING(6)        X Version 11 (August 1993)         XBOING(6)
  71.  
  72.  
  73.  
  74.       There    is a pirate symbol that    will kill your ball if
  75.       touched. You can shoot this block 3 times to kill it but you
  76.       will lose 1000 points. Keep away from    the Death block, it
  77.       kills    your ball!
  78.  
  79.       The walls off    block will turn    the wall bounce    off on both
  80.       the left and right side of the playing area. This will mean
  81.       the ball will    not bounce off but continue through the    wall
  82.       and wrap around to the other side respectively.
  83.  
  84.       The reverse block will when hit reverse the controls to the
  85.       paddle. This block should be avoided as it makes the game
  86.       really hard. Hitting another reverse while already in
  87.       reverse mode will turn it off.
  88.  
  89.       The teleport block will teleport the ball somewhere else on
  90.       that level. It will not place    you too    close to the bottom of
  91.       the screen or    on another block.
  92.  
  93.       The sticky paddle block will stick the ball to your paddle
  94.       each time it is hit and wait until you press space to    shoot
  95.       it off again.    This can be a #$%$#@! and also useful for
  96.       lining up shots for hard bricks.
  97.  
  98.       There    is a machine gun block that allows you to shoot    much
  99.       faster. Note that you    will also go through your bullets at a
  100.       great    rate. Can be fun to let    off a burst every now and
  101.       then.    Erases counter blocks very fast.
  102.  
  103.       An extra ball    symbol may appear and when shot    or hit with
  104.       another ball it will give you    an extra ball!
  105.  
  106.       There    is a shrink paddle block that will shrink you paddle
  107.       to a smaller size for    the level. If you currently have the
  108.       smallest paddle then it has no effect.
  109.  
  110.       There    is an expand paddle block that will grow you paddle to
  111.       a larger size    for the    level. If you currently    have the
  112.       largest paddle then it has no    effect.
  113.  
  114.       You can use the bullets to shoot the last pesky blocks or to
  115.       collet lots of You can use the bullets to shoot the last
  116.       pesky    blocks or to collet lots of bonus coins. You will be
  117.       given    4 bullets when a new level starts. If you lose a ball
  118.       you will be given a token 2 bullets. Use bullets wisely as
  119.       you will hate    yourself when there is one brick left and the
  120.       ball is missing it for ever.
  121.  
  122.       Throughout the game the bonus    coins will appear. Collect
  123.       these    for bonus points when the level    is finished. Sometimes
  124.       the coin may appear as a x2 or x4 symbol which will indicate
  125.       that the scoring from    now onwards will be multiplied by 2 or
  126.  
  127.  
  128.  
  129.      Page 2                          (printed 9/2/93)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XBOING(6)        X Version 11 (August 1993)         XBOING(6)
  137.  
  138.  
  139.  
  140.       4 respectively. Note:    if you get a x2    then x4    then x2    you
  141.       will go back to x2 mode. Also    note that this x2 or x4    mode
  142.       will be disabled after each ball death.
  143.  
  144.       If you collect more than 10 bonuses during a level the
  145.       killer mode is activated which will turn the ball red    and
  146.       the ball will    plough through all blocks except the solid
  147.       ones and finish off the level    very quickly. You will also
  148.       receive the SUPER BONUS on the bonus screen.
  149.  
  150.       The bonus screen will    tell you how you went in the last
  151.       level. Your bonuses will be added and    the bullet and level
  152.       bonus    will be    added. You get 500 points for each bullet not
  153.       used.    You get    3000 points for    each bonus and if you get more
  154.       than 10 bonuses you get a SUPER BONUS    of 50000 points. You
  155.       also get a new ball every 100,000 points. Pressing space
  156.       will skip the    bonus animations when the bonus    screen
  157.       appears. Your    bonus score will still be added.
  158.  
  159.       There    is a level timer that counts down while    playing    the
  160.       level. If you    don't complete the level in time you will not
  161.       get the time bonus which is 100 points per second remaining.
  162.       You will also    miss out on the    level bonus if your time runs
  163.       out.
  164.  
  165.       The ball will    be automatically shot off the paddle after
  166.       about    5 seconds unless you press the space bar. You can
  167.       always press P to pause the game.
  168.  
  169.       If the ball gets stuck in an infinite    loop it    will
  170.       automatically    tilt the board if the ball hasn't hit the
  171.       paddle after a certain time span. The    time span is about 8
  172.       seconds I think.
  173.  
  174.       XBoing was started like many other projects to learn Xlib
  175.       better. I had    the XPM    library    and was    already    using it in a
  176.       Motif    application. I thought that it would be    cool to    have
  177.       nice colour pictures/animations in an    Xlib game. So I    did.
  178.       Without the XPM library I would be still playing with    the
  179.       colours I think.
  180.  
  181.  
  182.      OPTIONS
  183.       The speed option will    adjust the speed of the    overall    game.
  184.       It will except integer numbers between 1 and 9. This option
  185.       is a little dodgy. The speed of the game can be changed from
  186.       within the game as well. See Game Control. The default value
  187.       is 1.
  188.  
  189.       The maxvol option allows you to adjust the maximum volume to
  190.       be used for the sound    effects    if sound is supported. It
  191.       doesn't mean all sounds will be this volume but they will
  192.  
  193.  
  194.  
  195.      Page 3                          (printed 9/2/93)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      XBOING(6)        X Version 11 (August 1993)         XBOING(6)
  203.  
  204.  
  205.  
  206.       use that volume as the top volume to scale against.
  207.  
  208.       The startlevel option    allows you to set the starting level
  209.       for your games. Note that when your score is placed in the
  210.       highscore table the level number is the number of levels
  211.       completed and    not the    level number attained. Also, in    the
  212.       bonus    screen your level bonus    will be    the number of levels
  213.       completed multiplied by the level bonus value    and not    the
  214.       current level    number!
  215.  
  216.       The help option will display a brief one line    description of
  217.       all the command line options used with xboing.
  218.  
  219.       The sync option will turn on the X Window System
  220.       synchronisation of all Xlib calls which means    that all calls
  221.       are flushed by the X server before continuing. This will
  222.       cause    the game to become slower but enable some debugging.
  223.       The default is OFF.
  224.  
  225.       The usage option will    print a    very brief synopsis of all the
  226.       command line options and there value ranges.
  227.  
  228.       The version option prints the    version    of xboing that you are
  229.       running.
  230.  
  231.       The scores option will print both the    roll of    honour and
  232.       your personal    best scores to standard    out. This can be
  233.       useful if you    are not    running    the program on an X window
  234.       display and still want to see    what the scores    are.
  235.  
  236.       The keys option will enable the use of the keyboard for game
  237.       control. Within the game you may press <g> to    toggle between
  238.       mouse    and key    control. The default is    MOUSE control.
  239.  
  240.       The sound option will    enable sound to    be turned on if
  241.       possible. The    default    is OFF.
  242.  
  243.       The setup option is useful when you have just    compiled the
  244.       program. It will display the paths of    the level & sound
  245.       directories and also give you    some information on other
  246.       things.
  247.  
  248.       The nosfx option will    turn OFF special effects. The special
  249.       effect in question at    this stage is the explosion shake.
  250.       Turning it off will speed the    game up    a little bit. The
  251.       default is ON. Servers without backing store will have it
  252.       turn off automatically as the    shaking    is shocking.
  253.  
  254.       The nograb option will make xboing not grab the pointer when
  255.       the game is visible. Pointer grabbing    has the    effect of
  256.       stopping you move the    pointer    outside    the game window. This
  257.       is useful as it constrains the mouse and you don't get
  258.  
  259.  
  260.  
  261.      Page 4                          (printed 9/2/93)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      XBOING(6)        X Version 11 (August 1993)         XBOING(6)
  269.  
  270.  
  271.  
  272.       colourmap flashes. The default is ON.
  273.  
  274.       The usedefcmap option    will make xboing try to    use the
  275.       default colourmap. This will be fine if the default
  276.       colourmap is reasonabily empty. If you have a    complex
  277.       picture on your background then this option will not work
  278.       and xboing will be unable to allocate    enough colours.
  279.  
  280.       The display option will allow    you to force the game to be
  281.       viewed on another display. The format    of the display name is
  282.       <xserver:0.0>    like most other    programs where xserver is the
  283.       name of the display. The default is your display of course.
  284.  
  285.       You may also set three environment variables used by xboing.
  286.       They specify the location of the level files,    sounds and the
  287.       highscore file. They are listed below.
  288.  
  289.       XBOING_SCORE_FILE = the highscore file to be used.
  290.       XBOING_LEVELS_DIR = the directory containing the levels.
  291.       XBOING_SOUND_DIR  = the directory containing the sounds.
  292.  
  293.       They will override the settings that are compiled into the
  294.       program.
  295.  
  296.  
  297.      GAME CONTROL
  298.       You must have    specified "-keys" on the command line to use
  299.       the keys for the paddle control. The default is to use the
  300.       mouse    control    method.
  301.  
  302.       J = Paddle Left
  303.       LeftArrow = Paddle Left
  304.       K = Shoot bullet
  305.       L = Paddle Right
  306.       RightArrow = Paddle Right
  307.  
  308.       All Mouse Buttons = Shoot Bullet/Start ball
  309.  
  310.       Use the mouse    to move    the paddle left    and right by moving the    mouse
  311.       left and right. The paddle will follow the mouse pointer. This is
  312.       the best method and easiest to use by    far.
  313.  
  314.       Space      = Start game
  315.       Escape  = End    game and return    to introduction.
  316.       i      = iconify the    game and pause.
  317.       H      = View roll of honour.
  318.       h      = View personal highscores.
  319.       p      = Pause game.
  320.       d      = Kill the ball.
  321.       a      = Toggle audio on/off
  322.       s      = Toggle special effects on/off
  323.       c      = Cycle through the intro screens.
  324.  
  325.  
  326.  
  327.      Page 5                          (printed 9/2/93)
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.      XBOING(6)        X Version 11 (August 1993)         XBOING(6)
  335.  
  336.  
  337.  
  338.       1-9     = Game    speed where 9 is fastest.
  339.       q      = Quit XBoing
  340.  
  341.       Note:    Highscores are saved at    the end    of each    game.
  342.  
  343.      SCORING
  344.       Each blocks has a certain point score. Some blocks such as
  345.       the counter block will have more than    one score associated
  346.       with it.
  347.  
  348.       red =    100
  349.       blue = 110
  350.       green    = 120
  351.       yellow = 140
  352.       tan =    130
  353.       purple = 150
  354.       bomb = 50 plus the surrounding blocks    points
  355.       wall = 0
  356.       pirate = 100
  357.       reverse = 100
  358.       ammo = 50 plus bullets
  359.       counter = 200    (each number).
  360.  
  361.       Each time the    paddle is hit with the ball your earn 10
  362.       points. I'm nice.
  363.  
  364.       There    are death symbols (a pirate) that when hit by a    ball
  365.       will kill the    ball. You can shoot them but you will lose
  366.       1000 points.
  367.  
  368.       The bonus coins are 3000 points - but    only added to score if
  369.       you reach the    end of the level and go    through    the bonus
  370.       screen.
  371.  
  372.       If you collect more than 10 bonus coins you get a Super
  373.       Bonus    of 50,000 points. Each remaining bullet    after a    level
  374.       is worth 500 points.
  375.  
  376.       At the end of    each level you are awarded a level bouns which
  377.       is level <n> x 1000 points. So for level 20 you get 20,000
  378.       points! If you fail to complete the level in the time
  379.       allotted you will not    receive    a level    bonus.
  380.  
  381.       There    are now    two highscore files. One displays the global
  382.       scores which will be your best score to date.    The other is a
  383.       personal high    score table with all your attempts.
  384.  
  385.  
  386.      SOUND SUPPORT
  387.       Xboing has limited support for sound.    It has sound code for
  388.       the following    machines :-
  389.  
  390.  
  391.  
  392.  
  393.      Page 6                          (printed 9/2/93)
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.      XBOING(6)        X Version 11 (August 1993)         XBOING(6)
  401.  
  402.  
  403.  
  404.       HP, SUN, NCD Xterminals, LINUX PC Soundblaster, RPLAY    sound
  405.       system.
  406.  
  407.       Most support and use the SUN .au format sound    files. The
  408.       linux    version    just sends the data down to the    audio device
  409.       which    may cause slight clicking sounds due to    the audio file
  410.       header. Future versions of xboing will support other
  411.       machines if patches are sent to me or    if I learn the sound
  412.       format. SGI will be next but they have their own format,
  413.       argghh. I am not going to have heaps of converted files all
  414.       over the place in different formats as the archive would be
  415.       HUGE.
  416.  
  417.  
  418.      LEVELS
  419.       The levels are not increasingly harder to play - some    are
  420.       but some are easy. This is because it    takes ages to create
  421.       and design levels. The paddle    does get smaller as the    game
  422.       goes on. This    makes it REALLY    hard. I    may also add a ball
  423.       speedup feature.
  424.  
  425.       The level data is a simple ASCII file    format that can    be
  426.       edited. The levels are loaded    when required from the
  427.       directory specified when the game was    made.
  428.  
  429.       You can create more levels if    you like making    sure that they
  430.       are in the correct format and    that they have a correct
  431.       filename format.
  432.  
  433.       Copy level0.data to level??.data and use that    for the
  434.       editing of new levels.
  435.  
  436.       level    format:     (case sensitive)
  437.  
  438.           w    = wall block
  439.           r    = red block
  440.           g    = green    block
  441.           b    = blue block
  442.           t    = tan block
  443.           p    = purple block
  444.           y    = yellow block
  445.           X    = Bomb
  446.           B    = Ammo
  447.           .    = blank
  448.           D    = Death
  449.           R    = Reverse
  450.           H    = Teleport
  451.           L    = Extra    ball
  452.           M    = Machine Gun
  453.           W    = Walls    off
  454.           ?    = Random block
  455.           m    = Multiple balls
  456.  
  457.  
  458.  
  459.      Page 7                          (printed 9/2/93)
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.      XBOING(6)        X Version 11 (August 1993)         XBOING(6)
  467.  
  468.  
  469.  
  470.           s    = sticky block
  471.           <    = Shrink paddle    block
  472.           >    = Grow paddle block
  473.  
  474.       The format of    the level is shown in the newlevel.data    file
  475.       in the source    distribution in    the levels directory.
  476.  
  477.       Make sure you    have a level title and a time bonus in
  478.       seconds.
  479.  
  480.  
  481.      NOTES
  482.       Obatin all new versions from ftp.x.org or a mirror site.
  483.  
  484.  
  485.      REDISTRIBUTION
  486.       (c) Copyright    1993, Justin C.    Kibell,    All Rights Reserved
  487.  
  488.       Permission to    use, copy, modify, and distribute this
  489.       software and its documentation without written agreement is
  490.       hereby granted. You cannot sell this software    without
  491.       written permission from the author. This entire copyright
  492.       notice must appear in    all copies of this software.
  493.  
  494.       IN NO    EVENT SHALL THE    AUTHOR BE LIABLE TO ANY    PARTY FOR
  495.       DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
  496.       DAMAGES ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS
  497.       DOCUMENTATION, EVEN IF THE AUTHOR HAS    BEEN ADVISED OF    THE
  498.       POSSIBILITY OF SUCH DAMAGE.
  499.  
  500.       THE AUTHOR SPECIFICALLY DISCLAIMS ANY    WARRANTIES, INCLUDING,
  501.       BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  502.       MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.     THE
  503.       SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE
  504.       AUTHOR HAS NO    OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT,
  505.       UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  506.  
  507.  
  508.      AUTHOR
  509.       Justin C. Kibell - Systems Programmer    - CATT Centre CITRI
  510.       Melbourne - Victoria - Australia.  email: jck@citri.edu.au
  511.       SnailMail: 1/17 Albert Road, North Warrandyte, Victoria,
  512.       Australia, 3113
  513.  
  514.       Computer Science Graduate - Royal Melbourne Institute    of
  515.       Technology (RMIT) - Australia
  516.  
  517.  
  518.      BUGS
  519.       See README documents in source distribution for list of bugs
  520.       and bug fixes.
  521.  
  522.  
  523.  
  524.  
  525.      Page 8                          (printed 9/2/93)
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.      XBOING(6)        X Version 11 (August 1993)         XBOING(6)
  533.  
  534.  
  535.  
  536.       Mail all bug reports/suggestions to jck@citri.edu.au
  537.       specifying the version and machine type you are using. Use
  538.       'uname -a' to    explain    the machine type. Please note the
  539.       version of X11 that you have installed as well, ie: X11R5,
  540.       X11R4, etc.
  541.  
  542.       Please note that xboing will run like    a pig on the xnews X
  543.       server distributed with Sun machines.    Please try to use the
  544.       MIT X    Server that comes with the X Window System.
  545.  
  546.  
  547.  
  548.  
  549.  
  550.  
  551.  
  552.  
  553.  
  554.  
  555.  
  556.  
  557.  
  558.  
  559.  
  560.  
  561.  
  562.  
  563.  
  564.  
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.  
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.      Page 9                          (printed 9/2/93)
  592.  
  593.  
  594.  
  595.